IMotion.SetAxisPositiveLimitSwitch method

Sets a positive limit switch for an axis.

Namespace: IntervalZero.KINGSTAR.Base.Api

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

KsError SetAxisPositiveLimitSwitch(
       int Index,
       bool AxisSwitch,
       int ModuleIndex,
       int BitOffset,
       bool Invert,
       bool Enable
)

Function SetAxisPositiveLimitSwitch(
       Index As Integer,
       AxisSwitch As Boolean,
       ModuleIndex As Integer,
       BitOffset As Integer,
       Invert As Boolean,
       Enable As Boolean
) As KsError

Parameters

Index

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

AxisSwitch

Type: bool

Set to true if the sensor is connected to an axis input, or set to false if it is connected to an I/O module.

ModuleIndex

Type: int

identifies which axis or I/O module contains the sensor. Aliases affect this parameter.

BitOffset

Type: int

The offset in bit of the sensor digital input in the module input variables.

Invert

Type: bool

Inverts the sensor value.

Enable

Type: bool

true: enables a positive limit switch. false: disables the positive limit switch.

Return value

Type: KsError

A return code of a method.

Remarks

Used to select a digital input to use as a positive limit switch.

Examples

N/A